feat(webapi): saveScreenshot with custom path by kobenguyent · Pull Request #5469 · codeceptjs/CodeceptJS

kobenguyent · 2026-03-04T16:39:21Z

Motivation/Description of the PR

Description of this PR, which problem it solves
Resolves #issueId (if applicable).

Applicable helpers:

Type of change

Checklist:

Tests have been added
Documentation has been added (Run npm run docs)
Lint checking (Run npm run lint)
Local tests are passed (Run npm test)

Bumps [playwright](https://github.com/microsoft/playwright) from 1.53.0 to 1.54.1. - [Release notes](https://github.com/microsoft/playwright/releases) - [Commits](microsoft/playwright@v1.53.0...v1.54.1) --- updated-dependencies: - dependency-name: playwright dependency-version: 1.54.1 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

--- updated-dependencies: - dependency-name: "@eslint/js" dependency-version: 9.31.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [expect](https://github.com/jestjs/jest/tree/HEAD/packages/expect) from 29.7.0 to 30.0.4. - [Release notes](https://github.com/jestjs/jest/releases) - [Changelog](https://github.com/jestjs/jest/blob/main/CHANGELOG.md) - [Commits](https://github.com/jestjs/jest/commits/v30.0.4/packages/expect) --- updated-dependencies: - dependency-name: expect dependency-version: 30.0.4 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [graphql](https://github.com/graphql/graphql-js) from 16.10.0 to 16.11.0. - [Release notes](https://github.com/graphql/graphql-js/releases) - [Commits](graphql/graphql-js@v16.10.0...v16.11.0) --- updated-dependencies: - dependency-name: graphql dependency-version: 16.11.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [electron](https://github.com/electron/electron) from 37.1.0 to 37.2.3. - [Release notes](https://github.com/electron/electron/releases) - [Changelog](https://github.com/electron/electron/blob/main/docs/breaking-changes.md) - [Commits](electron/electron@v37.1.0...v37.2.3) --- updated-dependencies: - dependency-name: electron dependency-version: 37.2.3 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [axios](https://github.com/axios/axios) from 1.8.4 to 1.11.0. - [Release notes](https://github.com/axios/axios/releases) - [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md) - [Commits](axios/axios@v1.8.4...v1.11.0) --- updated-dependencies: - dependency-name: axios dependency-version: 1.11.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

) Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.7.0 to 4.7.1. - [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases) - [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md) - [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.7.1/packages/typedoc-plugin-markdown) --- updated-dependencies: - dependency-name: typedoc-plugin-markdown dependency-version: 4.7.1 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [browser-actions/setup-chrome](https://github.com/browser-actions/setup-chrome) from 1 to 2. - [Release notes](https://github.com/browser-actions/setup-chrome/releases) - [Changelog](https://github.com/browser-actions/setup-chrome/blob/master/CHANGELOG.md) - [Commits](browser-actions/setup-chrome@v1...v2) --- updated-dependencies: - dependency-name: browser-actions/setup-chrome dependency-version: '2' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.7 to 0.28.10. - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](TypeStrong/typedoc@v0.28.7...v0.28.10) --- updated-dependencies: - dependency-name: typedoc dependency-version: 0.28.10 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: hook exit code * Update asyncWrapper.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update asyncWrapper.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update asyncWrapper.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update asyncWrapper.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update asyncWrapper.js * Update asyncWrapper.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…5072) * fix share workers * fix share workers

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v4...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [tsd](https://github.com/tsdjs/tsd) from 0.32.0 to 0.33.0. - [Release notes](https://github.com/tsdjs/tsd/releases) - [Commits](tsdjs/tsd@v0.32.0...v0.33.0) --- updated-dependencies: - dependency-name: tsd dependency-version: 0.33.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

) Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.7.1 to 4.8.1. - [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases) - [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md) - [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.8.1/packages/typedoc-plugin-markdown) --- updated-dependencies: - dependency-name: typedoc-plugin-markdown dependency-version: 4.8.1 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

#5073)

* release 3.7.4

…Timeout` value at the end of test suite (#5077) * Initial plan * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Initial plan * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

#5082) * Initial plan * Fix JUnit XML test case name inconsistency in scenario retries Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Improve edge case handling for empty suite titles in cloned tests Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* fix: TestCafe_test.js * Fix TestCafe form submission timeout with efficient polling mechanism (#5080) * Initial plan * Fix failed TestCafe tests by skipping doubleClick test * Update testcafe.yml * Update testcafe.yml * Update TestCafe_test.js * Update TestCafe_test.js * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Fix TestCafe form submission timeout in CI environments * Improve TestCafe form submission timeout handling with polling mechanism Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Improve TestCafe form submission timeout with efficient polling mechanism Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Update testcafe.yml * fix: Chrome popup causes problems with TestCafe --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> Co-authored-by: kobenguyent <kobenguyent@gmail.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

* Initial plan * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Add TypeScript types for Feature.only method * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Fix TypeScript test expectations for hook return types Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Initial plan * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> * Changes before error encountered Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

DavertMik

Can we just split filename path and create folders automatically?

I.saveScreenshot('custom/debug.png') will create output/custom/debug.png

kobenguyent · 2026-03-06T09:10:29Z

Can we just split filename path and create folders automatically?

I.saveScreenshot('custom/debug.png') will create output/custom/debug.png

I may get it wrongly as #5404 request may try to save the screenshot to custom path not inside the output folder.

DavertMik · 2026-03-09T20:57:56Z

@kobenguyent we can use absolute paths to handle this

if provided path is absolute -> save into it

so use could use it like this:

I.saveSceenshot(path.join(global.mySpecialPath, 'screenshot1'))

I dont see a need for another very similar method
it will be confusing to users and AI agents

Just detect global paths and provide such solution in UI
If user wants different ways they can create their own similar methods like

I.saveScreenshotToMyPath()
I.saveScreenshotToMyOtherPath()

inside custom steps file

kobenguyent · 2026-03-10T04:16:52Z

I see. Initially, I was thinking to reimplement the same function but I thought it may be backwards compatibility so that's why I introduced the new one.

kobenguyent · 2026-05-26T03:42:35Z

@copilot resolve conflicts with main branch (4.x)

- Resolve all merge conflicts, accepting 4.x as base - Retain feature: screenshotOutputFolder now supports absolute paths and relative subdirectory paths (e.g. 'custom/debug.png' -> output/custom/debug.png) - Use path.isAbsolute() for cross-platform compatibility - Create subdirectories automatically when output dir exists - Update tests and docs to reflect new behavior

… custom paths

Copilot · 2026-05-26T03:59:56Z

@copilot resolve conflicts with main branch (4.x)

Resolved conflicts with the 4.x branch in commit d45bf56. Key changes during the merge:

All merge conflicts resolved, using 4.x as the base (ES modules, store.outputDir)
Updated screenshotOutputFolder in lib/utils.js to use path.isAbsolute() for cross-platform path detection (addresses @DenysKuchma's Windows/POSIX concern)
Absolute paths save directly to the given location: I.saveScreenshot(path.join(myPath, 'debug.png'))
Relative paths with subdirectories save inside the output folder with auto-created subdirs: I.saveScreenshot('custom/debug.png') → output/custom/debug.png
Removed the separate saveScreenshotToPath method as requested by @DavertMik
Removed 3.x-only CommonJS test files incompatible with 4.x ES module setup

dependabot Bot and others added 30 commits July 16, 2025 09:36

chore(deps-dev): bump puppeteer from 24.8.0 to 24.15.0 (#5054)

2aef872

chore(deps-dev): bump expect from 30.0.4 to 30.0.5 (#5064)

e090eb9

fix: 5070 issue (#5071)

220b73f

5066 unable to inject data between workers because of proxy object (#…

3cf5fe2

…5072) * fix share workers * fix share workers

feat: shuffle test suite order in run command (#5051)

4daabc8

fix: sessions playwright traces - naming convention and error handling (

ff63f70

#5073)

release 3.7.4 (#5075)

a483106

* release 3.7.4

update docs

2e4d0bb

fix: Update inquirer (#5076)

376c758

add docs

f0759ca

feat(cli): make test file hyperlink (#5078)

04ec768

DavertMik reviewed Mar 6, 2026

View reviewed changes

Added overwrites (#5477)

47451b3

kobenguyent added 2 commits March 11, 2026 14:27

resolve the path in filename

baa87d0

resolve the path in filename

8707915

kobenguyent requested review from DavertMik and thomashohn March 11, 2026 13:31

thomashohn approved these changes Mar 11, 2026

View reviewed changes

kobenguyent changed the title ~~feat(webapi): saveScreenshotToPath~~ feat(webapi): saveScreenshot with custom path Mar 11, 2026

Updated deps (#5488)

1324e07

DenysKuchma requested changes Mar 16, 2026

View reviewed changes

Comment thread lib/utils.js Outdated

Comment thread docs/helpers/Playwright.md

Comment thread docs/webapi/saveScreenshot.mustache Outdated

Comment thread test/helper/webapi.js Outdated

thomashohn and others added 5 commits March 16, 2026 15:07

Update actions (#5490)

11511b4

Bump versions (#5494)

051ced8

release 3.7.7 (#5495)

30a36a6

Merge branch '3.x' into feat/custom-screenshot-path

73b283e

address CR

ea9d4f8

kobenguyent requested a review from DenysKuchma March 18, 2026 14:23

kobenguyent added 2 commits March 18, 2026 15:26

fix failed tests

49ed69e

fix failed tests

e6945d4

kobenguyent requested a review from thomashohn March 18, 2026 14:27

thomashohn approved these changes Mar 19, 2026

View reviewed changes

kobenguyent changed the base branch from 3.x to 4.x May 26, 2026 03:41

Copilot started work on behalf of kobenguyent May 26, 2026 03:42 View session

Copilot AI added 2 commits May 26, 2026 03:59

Merge origin/4.x and update screenshotOutputFolder for cross-platform…

0de7369

… custom paths

Copilot finished work on behalf of kobenguyent May 26, 2026 04:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(webapi): saveScreenshot with custom path#5469

feat(webapi): saveScreenshot with custom path#5469
kobenguyent wants to merge 149 commits into
4.xfrom
feat/custom-screenshot-path

kobenguyent commented Mar 4, 2026 •

edited

Loading

Uh oh!

DavertMik left a comment

Uh oh!

kobenguyent commented Mar 6, 2026

Uh oh!

DavertMik commented Mar 9, 2026

Uh oh!

kobenguyent commented Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kobenguyent commented May 26, 2026

Uh oh!

Copilot AI commented May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

Uh oh!

Conversation

kobenguyent commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation/Description of the PR

Type of change

Checklist:

Uh oh!

DavertMik left a comment

Choose a reason for hiding this comment

Uh oh!

kobenguyent commented Mar 6, 2026

Uh oh!

DavertMik commented Mar 9, 2026

Uh oh!

kobenguyent commented Mar 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kobenguyent commented May 26, 2026

Uh oh!

Copilot AI commented May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

kobenguyent commented Mar 4, 2026 •

edited

Loading